|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for all Rover "actions" -- turning, moving, etc. All actions are assumed to be "safe"; they should always avoid collisions independently (and return false if they do)!
This used to be interface Motion, but was changed to allow for non-motion-related Rover commands, such as looking for a landmark or sending a message.
Method Summary | |
boolean |
doAction(Rover r)
Tries to start the action. |
long |
getImageUpdateTime()
Lets you know when the last image was taken by this action. |
java.awt.image.BufferedImage |
getRecentImage()
Returns the most recent image taken by this Action. |
int |
getReturnValue()
The return value of the Action. |
java.lang.String |
getShortSummary()
Provides a shortened version of the summary returned by getSummary. |
java.lang.String |
getSummary()
Provides a textual explanation of the Action, such as "turn 90 degrees" |
int |
getTime()
How long the action will take, in milliseconds. |
int |
getTimeRemaining()
How much time until the action finishes (in milliseconds), if it has already started. |
boolean |
isCompleted()
Whether the action has completed. |
boolean |
isSuccess()
Whether the action completed successfully. |
void |
kill()
Emergency stop - end the action immediately, if it's running. |
Method Detail |
public boolean doAction(Rover r)
public void kill()
public boolean isSuccess()
public boolean isCompleted()
public int getTime()
public int getTimeRemaining()
public int getReturnValue()
RoverState
,
ActionConstants
public java.lang.String getSummary()
public java.lang.String getShortSummary()
public java.awt.image.BufferedImage getRecentImage()
public long getImageUpdateTime()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |